-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Split openAPI files by tag #971
Draft
dexamundsen
wants to merge
4
commits into
main
Choose a base branch
from
dexamundsen/openapi-split
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| # Activity Log APIs, parameters & schema objects | ||
|
|
||
| paths: | ||
| /listActivityLogEntries: | ||
| parameters: | ||
| - $ref: '#/components/parameters/ActivityLogFilterUserEmail' | ||
| - $ref: '#/components/parameters/ActivityLogFilterExactMatch' | ||
| - $ref: '#/components/parameters/ActivityLogFilterResourceType' | ||
| - $ref: '#/components/parameters/ActivityLogFilterActivityType' | ||
| - $ref: './common.yaml#/components/parameters/Offset' | ||
| - $ref: './common.yaml#/components/parameters/Limit' | ||
| get: | ||
| description: List the activity log entries | ||
| operationId: listActivityLogEntries | ||
| tags: [ ActivityLog ] | ||
| responses: | ||
| 200: | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/ActivityLogEntryList' | ||
| 400: | ||
| $ref: './common.yaml#/components/responses/BadRequest' | ||
| 401: | ||
| $ref: './common.yaml#/components/responses/Unauthorized' | ||
| 500: | ||
| $ref: './common.yaml#/components/responses/ServerError' | ||
|
|
||
| /getActivityLogEntry: | ||
| parameters: | ||
| - $ref: '#/components/parameters/ActivityLogEntryId' | ||
| get: | ||
| description: Get an activity log entry | ||
| operationId: getActivityLogEntry | ||
| tags: [ ActivityLog ] | ||
| responses: | ||
| 200: | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/ActivityLogEntry' | ||
| 401: | ||
| $ref: './common.yaml#/components/responses/Unauthorized' | ||
| 404: | ||
| $ref: './common.yaml#/components/responses/NotFound' | ||
| 500: | ||
| $ref: './common.yaml#/components/responses/ServerError' | ||
|
|
||
| components: | ||
| parameters: | ||
| ActivityLogEntryId: | ||
| description: ID of the activity log entry | ||
| name: activityLogEntryId | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
|
|
||
| ActivityLogFilterUserEmail: | ||
| description: Text search on the activity log entry user email | ||
| name: userEmail | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: string | ||
|
|
||
| ActivityLogFilterExactMatch: | ||
| description: True if the user email filter should check for an exact match | ||
| name: exactMatch | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: boolean | ||
| default: false | ||
|
|
||
| ActivityLogFilterResourceType: | ||
| description: Filter on the activity log entry resource type | ||
| name: resourceType | ||
| in: query | ||
| required: false | ||
| schema: | ||
| $ref: '#/components/schemas/ResourceType' | ||
|
|
||
| ActivityLogFilterActivityType: | ||
| name: activityType | ||
| in: query | ||
| description: Filter on the activity log entry activity type | ||
| required: false | ||
| schema: | ||
| $ref: '#/components/schemas/ActivityType' | ||
|
|
||
| schemas: | ||
| ActivityLogEntryList: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/ActivityLogEntry' | ||
|
|
||
| ActivityLogEntry: | ||
| type: object | ||
| required: [ id, userEmail, logged, systemVersion, activityType ] | ||
| properties: | ||
| id: | ||
| type: string | ||
| nullable: false | ||
| userEmail: | ||
| type: string | ||
| nullable: false | ||
| logged: | ||
| type: string | ||
| format: date-time | ||
| nullable: false | ||
| systemVersion: | ||
| $ref: './common.yaml#/components/schemas/SystemVersion' | ||
| activityType: | ||
| $ref: '#/components/schemas/ActivityType' | ||
| resources: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/ResourceObject' | ||
| additionalInfo: | ||
| description: Additional information for specific activity types | ||
| type: object | ||
| properties: | ||
| exportModel: | ||
| description: (EXPORT_COHORT) Name of the export model used | ||
| type: string | ||
| nullable: true | ||
| recordsCount: | ||
| description: (EXPORT_COHORT, CREATE_REVIEW) Number of primary | ||
| entity records involved | ||
| type: integer | ||
| format: int64 | ||
| nullable: true | ||
|
|
||
| ActivityType: | ||
| type: string | ||
| enum: [ 'CREATE_STUDY', 'DELETE_STUDY', 'CREATE_COHORT', 'DELETE_COHORT', | ||
| 'EXPORT_COHORT', 'CREATE_REVIEW', 'DELETE_REVIEW' ] | ||
|
|
||
| ResourceObject: | ||
| type: object | ||
| required: [ type, studyId ] | ||
| properties: | ||
| type: | ||
| $ref: '#/components/schemas/ResourceType' | ||
| studyId: | ||
| $ref: './studies.yaml#/components/schemas/StudyId' | ||
| studyDisplayName: | ||
| $ref: './studies.yaml#/components/schemas/StudyDisplayName' | ||
| studyProperties: | ||
| $ref: './common.yaml#/components/schemas/Properties' | ||
| cohortId: | ||
| $ref: './cohorts.yaml#/components/schemas/CohortId' | ||
| cohortDisplayName: | ||
| $ref: './cohorts.yaml#/components/schemas/CohortDisplayName' | ||
| cohortRevisionId: | ||
| $ref: './cohorts.yaml#/components/schemas/CohortRevisionId' | ||
| reviewId: | ||
| $ref: './reviews.yaml#/components/schemas/ReviewId' | ||
| reviewDisplayName: | ||
| $ref: './reviews.yaml#/components/schemas/ReviewDisplayName' | ||
|
|
||
| ResourceType: | ||
| type: string | ||
| enum: [ 'STUDY', 'COHORT', 'REVIEW' ] | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?