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

purl2all: Create doc for PURL services accessible through the API #445

Closed
1 task done
pombredanne opened this issue May 30, 2024 · 6 comments
Closed
1 task done

purl2all: Create doc for PURL services accessible through the API #445

pombredanne opened this issue May 30, 2024 · 6 comments
Assignees
@JonoYang @AyanSinhaMahapatra

Comments

@pombredanne
Copy link
Member

pombredanne commented May 30, 2024 •
edited
Loading

We want to make sure that:

  • Ensure that the latest PurlDB API deployed
    • This also provides the API documentation
@pombredanne pombredanne mentioned this issue May 30, 2024
Closed
4 tasks
@JonoYang
Copy link
Member

JonoYang commented May 30, 2024 •
edited by pombredanne
Loading

Pages we'll need:

  • Installation
    • PurlDB
      • Package scan worker
    • MatchCode.io
  • Overview of API endpoints and examples on how to communicate with it
    • packages
    • update_packages
    • package_sets
    • resources
    • approximate_directory_content_index
    • approximate_directory_structure_index
    • exact_file_index
    • exact_package_archive_index
    • cditems
    • on_demand_queue
    • validate
    • collect
    • watch (Now tracked in Document the purlwatch feature #474 )
    • scan_queue
    • matching
    • to_purl
    • from_purl
  • MatchCode.io matching Create doc/tutorial for matching with MatchCode #241
  • Organize, proofread, edit

@AyanSinhaMahapatra AyanSinhaMahapatra mentioned this issue May 30, 2024
Merged
JonoYang added a commit that referenced this issue May 31, 2024
@JonoYang
Add installation steps for PurlDB, MatchCode, and scan worker #241 #445
29ecd66 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue May 31, 2024
@JonoYang
Add docs for packages API #241 #445
4b71347 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue May 31, 2024
@JonoYang
Add documentation about resource API endpoint #241 #445
3884962 
Signed-off-by: Jono Yang <[email protected]>
@pombredanne
Copy link
Member Author

For reference the API doc is at https://public.purldb.io/api/docs/

JonoYang added a commit that referenced this issue May 31, 2024
@JonoYang
Add documentation for validate_purl, collect, and scan_queue #445
3bfb630 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 1, 2024
@JonoYang
Detail package update set and package set endpoints #241 #445
932498d 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 1, 2024
@JonoYang
Remove unneeded API endpoints #241 #445 #453
be8f77a 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 1, 2024
@JonoYang
Remove unneeded API endpoints #241 #445 #453
802daf5 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 1, 2024
@JonoYang
Add documentation for to_purl and from_purl #241 #445
c57783f 
Signed-off-by: Jono Yang <[email protected]>
@JonoYang
Copy link
Member

JonoYang commented Jun 1, 2024

@pombredanne I am removing some API endpoints that we don't need in #453

JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add installation steps for PurlDB, MatchCode, and scan worker #241 #445
b276c11 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add docs for packages API #241 #445
c01a974 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add documentation about resource API endpoint #241 #445
5e1cbf2 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add documentation for validate_purl, collect, and scan_queue #445
e074c1d 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Detail package update set and package set endpoints #241 #445
de0661e 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Remove unneeded API endpoints #241 #445 #453
0d18dc7 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add documentation for to_purl and from_purl #241 #445
5e1d6aa 
Signed-off-by: Jono Yang <[email protected]>
@pombredanne pombredanne mentioned this issue Jun 3, 2024
Merged
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Remove API for clearcode and matchcode #241 #445 #453
b14bb8c 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Document api/matching endpoint #241 #445
dd9d8ed 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
cfcde1c 
    * Add rest_api.rst to toctree

Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
e7cd09c 
    * Add rest_api.rst and installation.rst to their respective toctrees

Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
3cf2904 
    * Add rest_api.rst and installation.rst to their respective toctrees

Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
ec23f88 
    * Add rest_api.rst and installation.rst to their respective toctrees

Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
1ca1c49 
    * Add rest_api.rst and installation.rst to their respective toctrees

Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add installation steps for PurlDB, MatchCode, and scan worker #241 #445
c5182d6 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add docs for packages API #241 #445
c7e399f 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add documentation about resource API endpoint #241 #445
2af3ecc 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add documentation for validate_purl, collect, and scan_queue #445
00b9fb6 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Detail package update set and package set endpoints #241 #445
f5d19ef 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Remove unneeded API endpoints #241 #445 #453
767f0b7 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Add documentation for to_purl and from_purl #241 #445
0cab7e3 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Remove API for clearcode and matchcode #241 #445 #453
116b8f3 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Document api/matching endpoint #241 #445
705ed08 
Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
2292976 
    * Add rest_api.rst and installation.rst to their respective toctrees

Signed-off-by: Jono Yang <[email protected]>
JonoYang added a commit that referenced this issue Jun 3, 2024
@JonoYang
Rename api.rst to rest_api.rst #241 #445
045e259 
    * Add rest_api.rst and installation.rst to their respective toctrees

Signed-off-by: Jono Yang <[email protected]>
@pombredanne
Copy link
Member Author

pombredanne commented Jun 13, 2024 •
edited
Loading

This is completed and available at https://public.purldb.io/api/docs/ for the API docs and at https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/index.html for the overall docs

@pombredanne
Copy link
Member Author

pombredanne commented Jun 13, 2024 •
edited
Loading

Actually @keshav-space can you add doc on the purlwatch feature?

@pombredanne pombredanne reopened this Jun 13, 2024
@pombredanne
Copy link
Member Author

See #474 for a follow up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JonoYang JonoYang

@AyanSinhaMahapatra AyanSinhaMahapatra

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@pombredanne @JonoYang @AyanSinhaMahapatra