search

Boavizta / boaviztapi

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API
GNU Affero General Public License v3.0
66 stars 23 forks source link

211 missing docker port mapping in doc examples #212

Closed demeringo closed 9 months ago

demeringo commented 10 months ago

Small doc fixes for #211

da-ekchajzer commented 9 months ago

Thanks for the port correction. I am not sure that we should hard code the version in the doc since it will be changing on a regular basis. What do you think ?

demeringo commented 9 months ago

Thanks for the port correction. I am not sure that we should hard code the version in the doc since it will be changing on a regular basis. What do you think ?

It still think it can be usefull for a beginner just wanting to quicly test a local API with docker. My understanding is that mapping a port with the -p is mandatory to access the API from outside the container, so I prefer to add it to the doc.

da-ekchajzer commented 9 months ago

Of course, for the port. I was talking about the version number.

demeringo commented 9 months ago

Of course, for the port. I was talking about the version number.

;-) ... Still I think we should indicate version number (at least until we make "latest" tag point to the latest version of main or dev branch). Today a very old version of API is returned with "latest" tag which may confuse a newcommer (and sometimes also an oldcommer like me ;-) ) see #210

demeringo commented 9 months ago

@da-ekchajzer please forget my comment about explicit version tag in the docker comment, the underlying issue does not exist !

demeringo commented 9 months ago

I will remove the tag from code exemples and update this PR...