Split openAPI files by tag #971
Conversation
| 500: | ||
| $ref: "#/components/responses/ServerError" | ||
| /v2/profile: | ||
| $ref: './users.yaml#/paths/~1getMe' |
There was a problem hiding this comment.
Can't say I love these weird refs or having to list all the APIs here. This is the only way to split it?
There was a problem hiding this comment.
openapi spec demands this approach for splitting it. https://swagger.io/docs/specification/using-ref/
| @@ -2,2941 +2,166 @@ openapi: 3.0.3 | |||
| info: | |||
| title: Tanagra Service API | |||
| description: github.com/DataBiosphere/tanagra | |||
| version: 0.0.0 | |||
| version: 0.0.1 | |||
There was a problem hiding this comment.
If none of the APIs changed, why bump the version?
There was a problem hiding this comment.
can revert this, thought was that we actually have a deployed version, so '0' might be stale
| type: number | ||
| format: double | ||
|
|
||
| # --------------- Criteria --------------- |
There was a problem hiding this comment.
Criteria are a piece of a cohort or data feature set, not part of the query api or entity model.
| # Underlay-Entity APIs, parameters & schema objects | ||
|
|
||
| paths: | ||
| /listEntities: |
There was a problem hiding this comment.
I think the entity endpoints fit better with the underlay endpoints. Most of the rest of this file are the query endpoints. So perhaps also renaming this to query.yaml would be helpful.
|
|
||
| paths: | ||
| # --------------- Unauthenticated Paths --------------- | ||
|
|
||
| "/status": | ||
| /status: |
There was a problem hiding this comment.
Perhaps moving the unauthenticated endpoints to their own file (e.g. unauthenticated.yaml) would be clearer, so we always follow the same pattern when adding new endpoints.
There was a problem hiding this comment.
Sure I can move them
| - $ref: '#/components/parameters/ActivityLogFilterExactMatch' | ||
| - $ref: '#/components/parameters/ActivityLogFilterResourceType' | ||
| - $ref: '#/components/parameters/ActivityLogFilterActivityType' | ||
| - $ref: './common.yaml#/components/parameters/Offset' |
There was a problem hiding this comment.
It would be great if we don't have to worry about where a shared object is in order to reference it. Could using the same approach that it looks like WSM is using obviate the need for this?
|
using this approach also needs a change in gradle plugin (from hidelake to openapitools), holding it till I get to those changes |
Split all the single open api file into multiple smaller files, by the path tags. No changes to any path, parameter or schema