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.

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

JSON API for documentation state #238

Merged
merged 7 commits into from
May 27, 2024
Merged

JSON API for documentation state #238

merged 7 commits into from
May 27, 2024

Conversation

tayloraswift
Copy link
Owner

@tayloraswift tayloraswift commented May 27, 2024

usage example:

$ curl \
    -H "Authorization: Unidoc 4297524282_184d38185839950a" \
    https://localhost:8443/ref/swift-json/1.0.1/state
{"id":1,"volume":"swift-json:1.0.1","graph":{"commit":"22ffd76580e58d8e99dcabc8521d80bbf71eaffa"},"phase":"ACTIVE"}

authorization header has form \(userID)_\(apiKey)

i’m not sure if this fully solves the CI workflow problem. but reading the JSON is much easier than parsing /tags page HTML.

the JSON schema is defined here and we will need to document it

@tayloraswift tayloraswift merged commit d969a79 into master May 27, 2024
2 checks passed
@tayloraswift tayloraswift deleted the ref-state-api branch May 27, 2024 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant