[FOLIO-1428] Fix API documentation creation for mod-users-bl Created: 20/Aug/18  Updated: 12/Nov/18  Resolved: 20/Aug/18

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: Marc Johnson Assignee: David Crossley
Resolution: Done Votes: 0
Labels: core, sprint45
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Sprint:

 Description   

Following the changes made last week to move the interface and schema definitions for mod-users-bl to be local to the module instead of in the shared raml repository, the API documentation no longer generates successfully. See https://jenkins-aws.indexdata.com/job/folio-org/job/mod-users-bl/job/master/21/console for details.

I tried using the tools locally (with a copy of the global config), however the amendments I made to generate the documentation from the local place resulted in lots of warnings about unrelated interfaces (that I think are in the shared repository).

David Crossley I'm hoping you can help with this given your increased familiarity with this area.



 Comments   
Comment by Marc Johnson [ 20/Aug/18 ]

Little did I realise that this was already fixed with this change: https://github.com/folio-org/folio-org.github.io/commit/be0af2bebd7d042b42d4efe064f27c9d5fabce33

Thanks David Crossley I now understand that I missed the excludes property in the configuration I was trying.

Comment by David Crossley [ 21/Aug/18 ]

Thanks for trying to deal with that.

Yes, as indicated in https://github.com/folio-org/folio-org.github.io/pull/239 the configuration for mod-users-bl needs to handle its non-standard configuration for the name of the shared git submodule – not sure why it needs to be like that.

Generated at Thu Feb 08 23:13:16 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.