Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add descriptions to Compliance API spec #870

Merged
merged 5 commits into from
Jan 26, 2022
Merged

Add descriptions to Compliance API spec #870

merged 5 commits into from
Jan 26, 2022

Conversation

avatarneil
Copy link

📚 Purpose

Adds some more descriptions to the Compliance API spec.

👌 Resolves:

Bad docs >:(

📦 Impacts:

n/a

@avatarneil avatarneil added bulldozer-merge bulldozer-update documentation Improvements or additions to documentation labels Jan 12, 2022
@avatarneil avatarneil self-assigned this Jan 12, 2022
@avatarneil avatarneil mentioned this pull request Jan 12, 2022
Closed
@changeset-bot
Copy link

changeset-bot bot commented Jan 12, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: da75378

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

janedotx
janedotx reviewed Jan 13, 2022
View reviewed changes
packages/mds-compliance-api/spec/flat-spec.json
@@ -193,7 +193,7 @@
]
}
],
"summary": "Get compliance snapshot_ids",
"summary": "Get compliance snapshot_ids given a token. Sometimes, an opaque token will be provided as part of a URI to point to a collection of snapshots, this endpoint can be utilized to access those snapshots.",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but what does "opaque" mean here? What's an opaque token, and conversely, what's a transparent token?

Copy link
Author

@avatarneil avatarneil Jan 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unreadable vs readable is how I like to think of it. An opaque token could be impossible for a user to derive useful information from, whereas a transparent one would be the inverse.

@avatarneil avatarneil requested a review from janedotx January 20, 2022 17:12
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@lacuna-tech-bulldozer lacuna-tech-bulldozer bot merged commit e32e2cf into develop Jan 26, 2022
@lacuna-tech-bulldozer lacuna-tech-bulldozer bot deleted the documentation/neil/add-descriptions-to-compliance-api-spec branch January 26, 2022 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdurling mdurling mdurling approved these changes

@PeterSP PeterSP PeterSP approved these changes

@nessur nessur nessur approved these changes

@marie-x marie-x Awaiting requested review from marie-x

@janedotx janedotx Awaiting requested review from janedotx

Assignees

@avatarneil avatarneil

Labels
bulldozer-merge documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@avatarneil @janedotx @nessur @PeterSP @mdurling